Skip to content

docs: add base workflow quick guide#1663

Closed
xmpace wants to merge 5 commits into
larksuite:mainfrom
xmpace:patch-1
Closed

docs: add base workflow quick guide#1663
xmpace wants to merge 5 commits into
larksuite:mainfrom
xmpace:patch-1

Conversation

@xmpace

@xmpace xmpace commented Jun 30, 2026 •
edited by coderabbitai Bot
Loading

Copy link
Copy Markdown

Summary

Add a quick-start reference for Base workflow tasks so agents can stay on the short path for list/get/enable/disable/title-preserving updates and only open the full workflow schema when needed.

Changes

  • Add lark-base-workflow-quick.md with workflow routing, create/update guidance, unsupported delete-trigger boundaries, and common step keys.
  • Update lark-base skill routing and workflow command tips/tests to point agents to the quick guide first.
  • Clarify that physical record delete triggers are not supported in the workflow guide/schema.

Test Plan

  • Unit tests pass: go test ./shortcuts/base
  • Unit tests pass: make unit-test
  • Verified PR branch diff against latest larksuite/cli:main contains only the intended 8 files from Codebase MR 769.

Related Issues

  • None

Summary by CodeRabbit

  • New Features

    • Added a new “Workflow quick” guide for Lark Base with shortcut-based paths for common workflow tasks (create, update, inspect).

  • Documentation

    • Updated workflow-related CLI help for +workflow-get, +workflow-create, and +workflow-update (including --json) to direct users to the quick guide first and explain when to use the full guide/schema.
    • Clarified unsupported physical record deletion (no delete trigger) and suggested status/flag-based modeling alternatives.
    • Refreshed workflow error guidance (e.g., undefined step type) and added minimal step data references.

  • Tests

    • Updated expected CLI help tip text for workflow commands.

@CLAassistant

CLAassistant commented Jun 30, 2026 •
edited
Loading

Copy link
Copy Markdown

CLA assistant check
All committers have signed the CLA.

@github-actions github-actions Bot added domain/base PR touches the base domain size/M Single-domain feat or fix with limited business impact labels Jun 30, 2026
@coderabbitai

coderabbitai Bot commented Jun 30, 2026 •
edited
Loading

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: b01af7e5-ff60-4937-945b-5bbf5526f8d7

📥 Commits

Reviewing files that changed from the base of the PR and between 922dae9 and 6d52454.

📒 Files selected for processing (8)
  • shortcuts/base/base_shortcuts_test.go
  • shortcuts/base/workflow_create.go
  • shortcuts/base/workflow_get.go
  • shortcuts/base/workflow_update.go
  • skills/lark-base/SKILL.md
  • skills/lark-base/references/lark-base-workflow-guide.md
  • skills/lark-base/references/lark-base-workflow-quick.md
  • skills/lark-base/references/lark-base-workflow-schema.md
✅ Files skipped from review due to trivial changes (8)
  • skills/lark-base/references/lark-base-workflow-guide.md
  • shortcuts/base/workflow_update.go
  • shortcuts/base/workflow_create.go
  • skills/lark-base/references/lark-base-workflow-schema.md
  • shortcuts/base/base_shortcuts_test.go
  • shortcuts/base/workflow_get.go
  • skills/lark-base/SKILL.md
  • skills/lark-base/references/lark-base-workflow-quick.md
📝 Walkthrough

Walkthrough

Adds lark-base-workflow-quick.md as the main workflow reference. CLI help text, SKILL.md, existing workflow docs, and shortcut tests are updated to point to it and align wording.

Changes

Workflow Quick Guide Introduction

Layer / File(s) Summary
New lark-base-workflow-quick.md reference guide
skills/lark-base/references/lark-base-workflow-quick.md		 Adds the quick workflow guide with command routing, create/update paths, unsupported delete boundaries, step data keys, required checks, schema pointers, and a minimal JSON body template.
Updates to existing workflow guide and schema docs
skills/lark-base/references/lark-base-workflow-guide.md, skills/lark-base/references/lark-base-workflow-schema.md		 Adds delete-trigger absence guidance and notes on modeling physical deletes without workflow delete triggers.
CLI command tips and flag descriptions
shortcuts/base/workflow_get.go, shortcuts/base/workflow_create.go, shortcuts/base/workflow_update.go		 Updates workflow shortcut tips and --json help text to reference lark-base-workflow-quick.md first.
SKILL.md routing and reference updates
skills/lark-base/SKILL.md		 Revises workflow routing guidance and reference ordering to include the new quick guide.
Test assertions updated for new tip text
shortcuts/base/base_shortcuts_test.go		 Updates expected workflow tip strings to match the revised quick-guide wording.

Estimated code review effort: 2 (Simple) | ~10 minutes

Possibly related PRs

  • larksuite/cli#345: Updates the same workflow shortcut help text in workflow_create.go and workflow_update.go.
  • larksuite/cli#374: Also changes workflow routing and reference guidance in skills/lark-base/SKILL.md.

Suggested labels: documentation

Suggested reviewers: kongenpei, zhouyue-bytedance

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Write docstrings for the functions missing them to satisfy the coverage threshold.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title is concise and accurately summarizes the main change: adding a Base workflow quick guide.
Description check ✅ Passed The description follows the required template and covers summary, changes, test plan, and related issues.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@xmpace
xmpace force-pushed the patch-1 branch 3 times, most recently from 5835a5d to 922dae9 Compare July 7, 2026 04:00
@xmpace xmpace closed this Jul 8, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

domain/base PR touches the base domain size/M Single-domain feat or fix with limited business impact

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@xmpace @CLAassistant